Skip to main content

get Registries​

Get all registries under a subscription

Path Parameters
    subscriptionId string required

    Subscription ID

Query Parameters
    pageNumber integer

    Page Number

    pageSize integer

    Page Size

    registryIds string[]

    A list of registry string IDs. For example, ['registry0', 'registry12']. If empty, this field is ignored. Maximum IDs: 10,000

Responses

OK

Schema
    deviceRegistries object[]
    id string

    Possible values: >= 3 characters and <= 256 characters

    name string
    parent string
    createdOn string
    updatedOn string
    credentials object[]
    publicKeyCertificate object
    certificate string
    format string

    Possible values: [X509_CERTIFICATE_PEM]

    x509Details object
    expiryTime string
    issuer string
    publicKeyType string
    signatureAlgorithm string
    startTime string
    subject string
    id string
    httpConfig object
    httpEnabledState string

    Possible values: [HTTP_ENABLED, HTTP_DISABLED, HTTP_STATE_UNSPECIFIED]

    mqttConfig object
    mqttEnabledState string

    Possible values: [MQTT_ENABLED, MQTT_DISABLED, MQTT_STATE_UNSPECIFIED]

    logLevel string

    Possible values: [INFO, ERROR]

    eventNotificationConfigs object[]
    pubsubTopicName string
    subfolderMatches string
    roleArn string
    region string
    stream string
    logNotificationConfig object
    pubsubTopicName string
    roleArn string
    region string
    stream string
    stateNotificationConfig object
    pubsubTopicName string
    roleArn string
    region string
    stream string
    customOnboardNotificationConfig object
    pubsubTopicName string
    roleArn string
    region string
    stream string
    customOnboardEnabled boolean
    routeTarget string

    Possible values: [pubsub, kinesis]

    numberOfDevices integer
    numberOfGateways integer
    pageNumber integer
    pageSize integer
    totalCount integer
Loading...